python项目用sphinx文档生成

python项目用sphinx文档生成

使用内置命令

sphinx-apidoc -o doc waterfal
得到 rst 文件

localhost:doc timger$ ls
modules.rst             waterfall.glblog.rst    waterfall.master.rst    waterfall.rst
waterfall.excepts.rst   waterfall.lib.rst       waterfall.p2plog.rst    waterfall.slowspeed.rst

自己编辑 conf.py
或者加上 -F

localhost:waterfall timger$ sphinx-apidoc -F -o doc waterfall
Creating file doc/waterfall.rst.
Creating file doc/waterfall.excepts.rst.
Creating file doc/waterfall.glblog.rst.
Creating file doc/waterfall.lib.rst.
Creating file doc/waterfall.master.rst.
Creating file doc/waterfall.p2plog.rst.
Creating file doc/waterfall.slowspeed.rst.
Creating file doc/conf.py.
Creating file doc/index.rst.
Creating file doc/Makefile.
Creating file doc/make.bat.

然后 直接 make html

注意需要在 conf.py 里面加入项目路径让他能够 import

如果路径很深 需要 -d 10 后面参数根据情况